Skip to main content

Get User ExtraField Validation List

GET : http://<base_url>/digipay/v3/user/user_extrafield_validation

This API is used to get new user extra field validation data into the system.

QUERY PARAMS:-

ParameterTypeDescriptionValue
extra_field_keyStringRepresents an additional key associated with the field, possibly for metadata or referencing purposes.sample_key
field_validation_keyStringRefers to a key used for validation purposes, often in a validation rule configuration.validation_key
field_validation_valueStringHolds a sample validation value or pattern that data should adhere to.validation_value
field_validation_minDoubleIndicates the minimum valid value for the field, useful in numeric or range-based validations.0.5
field_validation_maxDoubleRepresents the maximum valid value for the field, also relevant in numeric or range-based validations.10
skipIntSkip the first n document from the query result1
limitIntLimits the number of records or documents that you want1
start_dateLongunix timestamp value in second1
end_dateLongunix timestamp value in second1
sortingStringSorting of the Data in the form of a string123
search_keywordStringa keyword which can be either name of language or a language code to get desired language as output.123

HEADERS:-

ParameterTypedescriptionvalue
AuthorizationStringIt is a combination of type and token to authenticate user for the given tokenToken duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyIDStringCompany_id is a unique primary id, that is represent company detail76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request GET \
--url 'http://192.168.1.102:8014/digipay/v3/user/user_extrafield_validation?field_validation_key=validation_key&extra_field_key=sample_key&field_validation_min=0.5&field_validation_max=10&skip=1&limit=1&start_date=1&end_date=1&sorting=123&search_keyword=123' \
--header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
--header 'CompanyID: 76bc712200ca444fa334f9e55e5fd7a8' \
--header 'accept: application/json'

Response:-

Response 200(OK)

{
"success": 1,
"error": [],
"data": {
"user_extrafield_validation": [
{
"is_active": true,
"created_by": "9bd4be3864134c828788bf14962f6c34",
"created_date": 1674024500,
"updated_by": null,
"updated_date": 1674024500,
"id": "4bc6ba63954641c8976488be871fd41a",
"extra_field_key": "DigiPay",
"field_validation_key": "123",
"field_validation_value": "Input",
"field_validation_min": 45.4,
"field_validation_max": 35.4,
"field_validation_error": "error"
}
]
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}

RESPONSES :-

Status CodeDescription
200OK
400BAD REQUEST
404NOT FOUND
500INTERNAL SERVER ERROR